docs(provider): document custom registry format - #2864
Conversation
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 13bef008ad
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| kimi provider add https://registry.example.com/api.json --api-key YOUR_API_KEY | ||
| ``` | ||
|
|
||
| The key is sent to the registry as `Authorization: Bearer YOUR_API_KEY` and is also saved as the API key for every provider imported from the file. The top-level `example` key identifies the registry record, while the nested `id` becomes the provider ID. Likewise, the model object key creates the Kimi Code alias `example/example-model`, and the nested model `id` is sent to the upstream API. |
There was a problem hiding this comment.
The new section calls example/example-model an alias without explaining that this is the model name users select or reference, yet later field and refresh descriptions rely on “alias” and “namespace” to explain important behavior. Add a short parenthetical gloss at this first occurrence so non-technical readers can understand those rules without prior configuration knowledge.
AGENTS.md reference: docs/AGENTS.md:L44-L46
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Addressed in 13716a2c3: the first use now defines a model alias as the model name users select or reference in Kimi Code, with the same explanation mirrored in Chinese. Verified with git diff --check and pnpm -C docs run build; independent read-only review found no blockers. Leaving the thread unresolved for maintainer verification.
1 participant
Related Issue
Refs #1366
Problem
The provider documentation explains how to import a custom registry, but it does not document the
api.jsonshape, required fields, capability metadata, or refresh behavior. Users therefore have to infer the format from implementation details.What changed
This is intentionally limited to the documentation request. It does not add the longer-term
/modelsdiscovery/import idea mentioned in the issue.Verification
pnpm -C docs run buildgit diff --checkChecklist
gen-changesets; this documentation-only PR needs no changeset.gen-docsand verified the generated documentation build.